

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>UADK Acceleration for Compression &mdash; Ceph Documentation</title>
  

  
  <link rel="stylesheet" href="../../_static/ceph.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/ceph.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />

  
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/doctools.js"></script>
        <script src="../../_static/sphinx_highlight.js"></script>
    
    <script type="text/javascript" src="../../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../../genindex/" />
    <link rel="search" title="Search" href="../../search/" />
    <link rel="next" title="Bucket Logging" href="../bucket_logging/" />
    <link rel="prev" title="Metrics" href="../metrics/" /> 
</head>

<body class="wy-body-for-nav">

   
  <header class="top-bar">
    <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../">Ceph 对象网关</a></li>
      <li class="breadcrumb-item active">UADK Acceleration for Compression</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../../_sources/radosgw/uadk-accel.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
  </header>
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #eee" >
          

          
            <a href="../../" class="icon icon-home"> Ceph
          

          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search/" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../start/">Ceph 简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install/">安装 Ceph</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephadm/">Cephadm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rados/">Ceph 存储集群</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephfs/">Ceph 文件系统</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rbd/">Ceph 块设备</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../">Ceph 对象网关</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../frontends/">HTTP 前端</a></li>
<li class="toctree-l2"><a class="reference internal" href="../multisite/">多站配置</a></li>
<li class="toctree-l2"><a class="reference internal" href="../zone-features/">域的功能</a></li>
<li class="toctree-l2"><a class="reference internal" href="../placement/">存储池归置与存储类</a></li>
<li class="toctree-l2"><a class="reference internal" href="../multisite-sync-policy/">多站同步策略配置</a></li>
<li class="toctree-l2"><a class="reference internal" href="../pools/">存储池的配置</a></li>
<li class="toctree-l2"><a class="reference internal" href="../config-ref/">配置参考</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/">管理指南</a></li>
<li class="toctree-l2"><a class="reference internal" href="../account/">用户账户</a></li>
<li class="toctree-l2"><a class="reference internal" href="../s3/">S3 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../iam/">IAM API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rgw-cache/">数据缓存和 CDN</a></li>
<li class="toctree-l2"><a class="reference internal" href="../swift/">Swift API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../adminops/">管理操作 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/">Python 接口</a></li>
<li class="toctree-l2"><a class="reference internal" href="../nfs/">通过 NFS 导出</a></li>
<li class="toctree-l2"><a class="reference internal" href="../keystone/">与 OpenStack Keystone 对接</a></li>
<li class="toctree-l2"><a class="reference internal" href="../barbican/">与 OpenStack Barbican 对接</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vault/">与 HashiCorp Vault 对接</a></li>
<li class="toctree-l2"><a class="reference internal" href="../kmip/">与 KMIP 对接</a></li>
<li class="toctree-l2"><a class="reference internal" href="../opa/">与 Open Policy Agent 对接</a></li>
<li class="toctree-l2"><a class="reference internal" href="../multitenancy/">多租户</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compression/">压缩</a></li>
<li class="toctree-l2"><a class="reference internal" href="../ldap-auth/">LDAP 认证</a></li>
<li class="toctree-l2"><a class="reference internal" href="../encryption/">服务器端加密</a></li>
<li class="toctree-l2"><a class="reference internal" href="../bucketpolicy/">桶策略</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dynamicresharding/">动态的桶索引重分片</a></li>
<li class="toctree-l2"><a class="reference internal" href="../mfa/">多因子认证</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sync-modules/">同步模块</a></li>
<li class="toctree-l2"><a class="reference internal" href="../notifications/">Bucket Notifications</a></li>
<li class="toctree-l2"><a class="reference internal" href="../layout/">RADOS 中的数据布局</a></li>
<li class="toctree-l2"><a class="reference internal" href="../STS/">STS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../STSLite/">STS Lite</a></li>
<li class="toctree-l2"><a class="reference internal" href="../keycloak/">Keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="../session-tags/">Session Tags</a></li>
<li class="toctree-l2"><a class="reference internal" href="../role/">Role</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orphans/">Orphan List and Associated Tooliing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../oidc/">OpenID Connect Provider</a></li>
<li class="toctree-l2"><a class="reference internal" href="../troubleshooting/">故障排除</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../man/8/radosgw/">radosgw 手册页</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../man/8/radosgw-admin/">radosgw-admin 手册页</a></li>
<li class="toctree-l2"><a class="reference internal" href="../qat-accel/">使用 QAT 为加密和压缩提速</a></li>
<li class="toctree-l2"><a class="reference internal" href="../s3select/">S3-select</a></li>
<li class="toctree-l2"><a class="reference internal" href="../lua-scripting/">Lua Scripting</a></li>
<li class="toctree-l2"><a class="reference internal" href="../d3n_datacache/">D3N Data Cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cloud-transition/">Cloud Transition</a></li>
<li class="toctree-l2"><a class="reference internal" href="../metrics/">Metrics</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">UADK Acceleration for Compression</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#uadk-in-the-software-stack">UADK in the Software Stack</a></li>
<li class="toctree-l3"><a class="reference internal" href="#uadk-environment-setup">UADK Environment Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="#configuration">Configuration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../bucket_logging/">桶的日志记录</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../mgr/">Ceph 管理器守护进程</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mgr/dashboard/">Ceph 仪表盘</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../monitoring/">监控概览</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api/">API 文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../architecture/">体系结构</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/developer_guide/">开发者指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/internals/">Ceph 内幕</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../governance/">项目管理</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../foundation/">Ceph 基金会</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ceph-volume/">ceph-volume</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/general/">Ceph 版本（总目录）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/">Ceph 版本（索引）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security/">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../hardware-monitoring/">硬件监控</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary/">Ceph 术语</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../jaegertracing/">Tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../translation_cn/">中文版翻译资源</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../">Ceph</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
<div id="dev-warning" class="admonition note">
  <p class="first admonition-title">Notice</p>
  <p class="last">This document is for a development version of Ceph.</p>
</div>
  <div id="docubetter" align="right" style="padding: 5px; font-weight: bold;">
    <a href="https://pad.ceph.com/p/Report_Documentation_Bugs">Report a Documentation Bug</a>
  </div>

  
  <section id="uadk-acceleration-for-compression">
<h1>UADK Acceleration for Compression<a class="headerlink" href="#uadk-acceleration-for-compression" title="Permalink to this heading"></a></h1>
<p>UADK is a framework for applications to access hardware accelerators in a
unified, secure, and efficient way. UADK is comprised of UACCE, libwd and many
other algorithm libraries.</p>
<p>See <a class="reference external" href="https://github.com/ceph/ceph/pull/58336">Compressor UADK Support</a>.</p>
<section id="uadk-in-the-software-stack">
<h2>UADK in the Software Stack<a class="headerlink" href="#uadk-in-the-software-stack" title="Permalink to this heading"></a></h2>
<p>UADK is a general-purpose user space accelerator framework that uses shared
virtual addressing (SVA) to provide a unified programming interface for hardware
acceleration of cryptographic and compression algorithms.</p>
<p>UADK includes Unified/User-space-access-intended Accelerator Framework (UACCE),
which enables hardware accelerators that support SVA to adapt to UADK.</p>
<p>Currently, HiSilicon Kunpeng hardware accelerators have been registered with
UACCE. Through the UADK framework, users can run cryptographic and compression
algorithms using hardware accelerators instead of CPUs, freeing up CPU computing
power and improving computing performance.</p>
<p>A user can access the hardware accelerators by performing user-mode operations on
the character devices, or the use of UADK can be done via frameworks that have
been enabled by others including UADK support (for example, OpenSSL* libcrypto*,
DPDK, and the Linux* Kernel Crypto Framework).</p>
<p>See <a class="reference external" href="https://github.com/Linaro/uadk_engine">OpenSSL UADK Engine</a>.</p>
</section>
<section id="uadk-environment-setup">
<h2>UADK Environment Setup<a class="headerlink" href="#uadk-environment-setup" title="Permalink to this heading"></a></h2>
<p>UADK consists of UACCE, vendors’ drivers, and an algorithm layer. UADK requires the
hardware accelerator to support SVA, and the operating system to support IOMMU and
SVA. Hardware accelerators from different vendors are registered as different character
devices with UACCE by using kernel-mode drivers of the vendors.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>      <span class="o">+----------------------------------+</span>
      <span class="o">|</span>                <span class="n">apps</span>              <span class="o">|</span>
      <span class="o">+----+------------------------+----+</span>
           <span class="o">|</span>                        <span class="o">|</span>
           <span class="o">|</span>                        <span class="o">|</span>
   <span class="o">+-------+--------+</span>       <span class="o">+-------+-------+</span>
   <span class="o">|</span>   <span class="n">scheduler</span>    <span class="o">|</span>       <span class="o">|</span> <span class="n">alg</span> <span class="n">libraries</span> <span class="o">|</span>
   <span class="o">+-------+--------+</span>       <span class="o">+-------+-------+</span>
           <span class="o">|</span>                         <span class="o">|</span>
           <span class="o">|</span>                         <span class="o">|</span>
           <span class="o">|</span>                         <span class="o">|</span>
           <span class="o">|</span>                <span class="o">+--------+------+</span>
           <span class="o">|</span>                <span class="o">|</span> <span class="n">vendor</span> <span class="n">drivers</span><span class="o">|</span>
           <span class="o">|</span>                <span class="o">+-+-------------+</span>
           <span class="o">|</span>                  <span class="o">|</span>
           <span class="o">|</span>                  <span class="o">|</span>
        <span class="o">+--+------------------+--+</span>
        <span class="o">|</span>         <span class="n">libwd</span>          <span class="o">|</span>
<span class="n">User</span>    <span class="o">+----+-------------+-----+</span>
<span class="o">--------------------------------------------------</span>
<span class="n">Kernel</span>    <span class="o">+--+-----+</span>   <span class="o">+------+</span>
          <span class="o">|</span> <span class="n">uacce</span>  <span class="o">|</span>   <span class="o">|</span> <span class="n">smmu</span> <span class="o">|</span>
          <span class="o">+---+----+</span>   <span class="o">+------+</span>
              <span class="o">|</span>
          <span class="o">+---+------------------+</span>
          <span class="o">|</span> <span class="n">vendor</span> <span class="n">kernel</span> <span class="n">driver</span> <span class="o">|</span>
          <span class="o">+----------------------+</span>
<span class="o">--------------------------------------------------</span>
         <span class="o">+----------------------+</span>
         <span class="o">|</span>   <span class="n">HW</span> <span class="n">Accelerators</span>    <span class="o">|</span>
         <span class="o">+----------------------+</span>
</pre></div>
</div>
</section>
<section id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p>Kernel Requirement</p></li>
</ol>
<p>User needs to make sure that UACCE is already supported in Linux kernel. The kernel version
should be at least v5.9 with SVA (Shared Virtual Addressing) enabled.</p>
<p>UACCE may be built as a module or built into the kernel. Here’s an example to build UACCE
with hardware accelerators for the HiSilicon Kunpeng platform.</p>
<blockquote>
<div><div class="highlight-default notranslate"><div class="highlight"><pre><style type="text/css">
span.prompt1:before {
  content: "$ ";
}
</style><span class="prompt1"><span class="nv">CONFIG_IOMMU_SVA_LIB</span><span class="o">=</span>y</span>
<span class="prompt1"><span class="nv">CONFIG_ARM_SMMU</span><span class="o">=</span>y</span>
<span class="prompt1"><span class="nv">CONFIG_ARM_SMMU_V3</span><span class="o">=</span>y</span>
<span class="prompt1"><span class="nv">CONFIG_ARM_SMMU_V3_SVA</span><span class="o">=</span>y</span>
<span class="prompt1"><span class="nv">CONFIG_PCI_PASID</span><span class="o">=</span>y</span>
<span class="prompt1"><span class="nv">CONFIG_UACCE</span><span class="o">=</span>y</span>
<span class="prompt1"><span class="nv">CONFIG_CRYPTO_DEV_HISI_QM</span><span class="o">=</span>y</span>
<span class="prompt1"><span class="nv">CONFIG_CRYPTO_DEV_HISI_ZIP</span><span class="o">=</span>y</span>
</pre></div></div></div></blockquote>
<p>Make sure all these above kernel configurations are selected.</p>
<p>#. UADK enablement
If the architecture is aarch64, it will automatically download the UADK source code to build
the static library. If it runs on other architecture, user can enable it with build parameters
<cite>-DWITH_UADK=true</cite></p>
<p>#. Manual Build UADK
As the above paragraph shows, the UADK is enabled automatically, no need to build manually.
For developer who is interested in UADK, you can refer to the below steps for building.</p>
<blockquote>
<div><div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>clone<span class="w"> </span>https://github.com/Linaro/uadk.git</span>
<span class="prompt1"><span class="nb">cd</span><span class="w"> </span>uadk</span>
<span class="prompt1">mkdir<span class="w"> </span>build</span>
<span class="prompt1">./autogen.sh</span>
<span class="prompt1">./configure<span class="w"> </span>--prefix<span class="o">=</span><span class="nv">$PWD</span>/build</span>
<span class="prompt1">make</span>
<span class="prompt1">make<span class="w"> </span>install</span>
</pre></div></div><div class="admonition note">
<p class="admonition-title">Note</p>
<p>Without –prefix, UADK will be installed to /usr/local/lib by
default. If get error:”cannot find -lnuma”, please install
the <cite>libnuma-dev</cite>.</p>
</div>
</div></blockquote>
<ol class="arabic">
<li><p>Configure</p>
<p>Edit the Ceph configuration file (usually <code class="docutils literal notranslate"><span class="pre">ceph.conf</span></code>) to enable UADK
support for <em>zlib</em> compression:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">uadk_compressor_enabled</span><span class="o">=</span><span class="n">true</span>
</pre></div>
</div>
<p>The default value in <cite>global.yaml.in</cite> for <cite>uadk_compressor_enabled</cite> is false.</p>
</li>
</ol>
</section>
</section>



<div id="support-the-ceph-foundation" class="admonition note">
  <p class="first admonition-title">Brought to you by the Ceph Foundation</p>
  <p class="last">The Ceph Documentation is a community resource funded and hosted by the non-profit <a href="https://ceph.io/en/foundation/">Ceph Foundation</a>. If you would like to support this and our other efforts, please consider <a href="https://ceph.io/en/foundation/join/">joining now</a>.</p>
</div>


           </div>
           
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="../metrics/" class="btn btn-neutral float-left" title="Metrics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="../bucket_logging/" class="btn btn-neutral float-right" title="Bucket Logging" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2016, Ceph authors and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0).</p>
  </div>

   

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>